<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Global</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Global</h1>

    




<section>

<header>
    
        <h2>
        
        </h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        

        


<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>


        
    
    </div>

    

    

    

     

    

    

    
        <h3 class="subsection-title">Methods</h3>

        
            

    

    <h4 class="name" id="AdjustPolygonButton"><span class="type-signature"></span>AdjustPolygonButton<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    This function is called when the user clicks 'Adjust Polygon' button
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="edit_event.js.html">edit_event.js</a>, <a href="edit_event.js.html#line132">line 132</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="CreatePopupBubble"><span class="type-signature"></span>CreatePopupBubble<span class="signature">(left, top, innerhtml, dom_attach)</span><span class="type-signature"> &rarr; {string}</span></h4>

    



<div class="description">
    This function creates the popup bubble.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>left</code></td>
            

            <td class="type">
            
                
<span class="param-type">float</span>


            
            </td>

            

            

            <td class="description last">xlocation of the bubble</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>top</code></td>
            

            <td class="type">
            
                
<span class="param-type">float</span>


            
            </td>

            

            

            <td class="description last">ylocation of the bubble</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>innerhtml</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">extra html content for the bubble</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>dom_attach</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">id of the html element where it should be attached</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="bubble.js.html">bubble.js</a>, <a href="bubble.js.html#line15">line 15</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        
<div class="param-desc">
    bubble_name - dom element name for the popup bubble
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="CreatePopupBubbleCloseButton"><span class="type-signature"></span>CreatePopupBubbleCloseButton<span class="signature">(dom_bubble, close_button)</span><span class="type-signature"></span></h4>

    



<div class="description">
    This function creates the close button at the top-right corner of the popup bubble
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>dom_bubble</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">dom_bubble name</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>close_button</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last">function to run when the close button is pressed</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="bubble.js.html">bubble.js</a>, <a href="bubble.js.html#line56">line 56</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="DrawCanvasClosePolygon"><span class="type-signature"></span>DrawCanvasClosePolygon<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Handles when the user closes the polygon by right-clicking or clicking 
 on the first control point. For video events the bubble is slightly different
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="draw_event.js.html">draw_event.js</a>, <a href="draw_event.js.html#line99">line 99</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="DrawCanvasMouseDown"><span class="type-signature"></span>DrawCanvasMouseDown<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Handles when the user presses the mouse button down on the drawing
canvas.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="draw_event.js.html">draw_event.js</a>, <a href="draw_event.js.html#line63">line 63</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="FinishStartup"><span class="type-signature"></span>FinishStartup<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Finish the startup process:
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="startup.js.html">startup.js</a>, <a href="startup.js.html#line215">line 215</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="getQueryVariable"><span class="type-signature"></span>getQueryVariable<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    This function gets a variable from the URL (or the COOKIES)
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="browser.js.html">browser.js</a>, <a href="browser.js.html#line69">line 69</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="LMgetObjectField"><span class="type-signature"></span>LMgetObjectField<span class="signature">(xml, ind_object, name, frame)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Gets a field for an object from an xml. If frame value is provided, it gives the field at the given.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>xml</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">The xml containing the annotations</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>ind_object</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last">Index to the object to be displayed</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">name of the field to return.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>frame</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last">frame of interest</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="xml_accessors.js.html">xml_accessors.js</a>, <a href="xml_accessors.js.html#line10">line 10</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="LMnumberOfObjects"><span class="type-signature"></span>LMnumberOfObjects<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Returns number of LabelMe objects.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="xml_accessors.js.html">xml_accessors.js</a>, <a href="xml_accessors.js.html#line46">line 46</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="LoadAnnotation404"><span class="type-signature"></span>LoadAnnotation404<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Annotation file does not exist, so load template.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="startup.js.html">startup.js</a>, <a href="startup.js.html#line179">line 179</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="LoadAnnotationSuccess"><span class="type-signature"></span>LoadAnnotationSuccess<span class="signature">(xml)</span><span class="type-signature"></span></h4>

    



<div class="description">
    This function gets called if the annotation has been successfully loaded.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>xml</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">the xml regarding the current file</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="startup.js.html">startup.js</a>, <a href="startup.js.html#line59">line 59</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="LoadTemplate404"><span class="type-signature"></span>LoadTemplate404<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Annotation template does not exist for this folder, so load default
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="startup.js.html">startup.js</a>, <a href="startup.js.html#line187">line 187</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="LoadTemplateSuccess"><span class="type-signature"></span>LoadTemplateSuccess<span class="signature">(xml)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Actions after template load success
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>xml</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">the xml regarding the current file</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="startup.js.html">startup.js</a>, <a href="startup.js.html#line199">line 199</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="SetAllAnnotationsArray"><span class="type-signature"></span>SetAllAnnotationsArray<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Sets AllAnnotations array from LM_xml
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="startup.js.html">startup.js</a>, <a href="startup.js.html#line95">line 95</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="StartDrawEvent"><span class="type-signature"></span>StartDrawEvent<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    This function is called with the draw event is started.  It can be 
 triggered when the user (1) clicks on the base canvas.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="draw_event.js.html">draw_event.js</a>, <a href="draw_event.js.html#line8">line 8</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="StartEditEvent"><span class="type-signature"></span>StartEditEvent<span class="signature">(anno_id)</span><span class="type-signature"></span></h4>

    



<div class="description">
    This function is called with the edit event is started.  It can be
triggered when the user (1) clicks a polygon, (2) clicks the object in
the object list, (3) deletes a verified polygon.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>anno_id</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last">the id of the annotation being edited</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="edit_event.js.html">edit_event.js</a>, <a href="edit_event.js.html#line14">line 14</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="StartEditVideoEvent"><span class="type-signature"></span>StartEditVideoEvent<span class="signature">(anno_id, polygon_id)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Mirror function of StartEditEvent for video
It creates an aux annotation so that the code is compliant
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>anno_id</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last">the id of the annotation being edited</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>polygon_id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">the id of the html polygon element</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="edit_event.js.html">edit_event.js</a>, <a href="edit_event.js.html#line198">line 198</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="StartupLabelMe"><span class="type-signature"></span>StartupLabelMe<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Main entry point for the annotation tool.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="startup.js.html">startup.js</a>, <a href="startup.js.html#line4">line 4</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="StopDrawEvent"><span class="type-signature"></span>StopDrawEvent<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    This function is called when the draw event is finished.  It can be
 triggered when the user (1) closes the polygon and only one option is
 valid in the drop-down list (2) erases the last control point.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="draw_event.js.html">draw_event.js</a>, <a href="draw_event.js.html#line205">line 205</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="StopEditEvent"><span class="type-signature"></span>StopEditEvent<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    This function is called when the edit event is finished.  It can be
triggered when the user (1) clicks the close edit bubble button, 
(2) zooms, (3) submits an object label in the popup bubble, 
(4) presses the delete button in the popup bubble, (5) clicks the 
object in the object list, (6) presses the ESC key.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="edit_event.js.html">edit_event.js</a>, <a href="edit_event.js.html#line82">line 82</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="UndoCloseButton"><span class="type-signature"></span>UndoCloseButton<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Handles when the user presses the undo close button in response to
 the "What is this object?" popup bubble.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="draw_event.js.html">draw_event.js</a>, <a href="draw_event.js.html#line176">line 176</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
    

    

    
</article>

</section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AdjustEvent.html">AdjustEvent</a></li><li><a href="canvas.html">canvas</a></li><li><a href="file_info.html">file_info</a></li><li><a href="image.html">image</a></li></ul><h3>Global</h3><ul><li><a href="global.html#AdjustPolygonButton">AdjustPolygonButton</a></li><li><a href="global.html#CreatePopupBubble">CreatePopupBubble</a></li><li><a href="global.html#CreatePopupBubbleCloseButton">CreatePopupBubbleCloseButton</a></li><li><a href="global.html#DrawCanvasClosePolygon">DrawCanvasClosePolygon</a></li><li><a href="global.html#DrawCanvasMouseDown">DrawCanvasMouseDown</a></li><li><a href="global.html#FinishStartup">FinishStartup</a></li><li><a href="global.html#getQueryVariable">getQueryVariable</a></li><li><a href="global.html#LMgetObjectField">LMgetObjectField</a></li><li><a href="global.html#LMnumberOfObjects">LMnumberOfObjects</a></li><li><a href="global.html#LoadAnnotation404">LoadAnnotation404</a></li><li><a href="global.html#LoadAnnotationSuccess">LoadAnnotationSuccess</a></li><li><a href="global.html#LoadTemplate404">LoadTemplate404</a></li><li><a href="global.html#LoadTemplateSuccess">LoadTemplateSuccess</a></li><li><a href="global.html#SetAllAnnotationsArray">SetAllAnnotationsArray</a></li><li><a href="global.html#StartDrawEvent">StartDrawEvent</a></li><li><a href="global.html#StartEditEvent">StartEditEvent</a></li><li><a href="global.html#StartEditVideoEvent">StartEditVideoEvent</a></li><li><a href="global.html#StartupLabelMe">StartupLabelMe</a></li><li><a href="global.html#StopDrawEvent">StopDrawEvent</a></li><li><a href="global.html#StopEditEvent">StopEditEvent</a></li><li><a href="global.html#UndoCloseButton">UndoCloseButton</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Mar 12 2015 16:00:31 GMT-0700 (PDT)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>